This config section holds settings for the IMAP Push module. This module pushes email to IMAP servers based on addresses and rules
The following settings can be used in this section:
Enable
You can turn on/off all IMAP Push activity using this switch
bool
On/Off, True/False, Yes/No, 1/0
On
Enable=On
IMAPAccountxEnable
bool
On/Off, True/False, Yes/No, 1/0
true
IMAPAccount%dEnable=true
IMAPAccountxUserName
Accounts require a username and password login to allow uploading of email.
This is the username or login name you provide to access this account and is used by the IMAP Push module to automatically login to upload the email to this account
text
IMAPAccountxName
A unique name associated with this account used to identify this account.
Typically this should be the email address of the account you are uploading to, so if you are uploading email to an ISP this could be for example myuser@myisp.com
text
IMAPAccountxPassword
Accounts require a username and password login to allow uploading of email.
This is the password you provide to access this account and is used by the IMAP Push to automatically login to get upload email to this account
encryptedtext
IMAPAccountxUseSSL
You can optionally specify to use SSL when connecting to this account.
Check that the server you are collecting from supports SSL before using this setting.
If you enable this and the server does not support SSL an error will occur in the log and no email will be collected.
Remember to ensure the port setting is correct for SSL IMAP (usually 993 instead of 143), and ensure the server name is specified as a name and not an IP address.
bool
On/Off, True/False, Yes/No, 1/0
false
IMAPAccount%dUseSSL=false
IMAPAccountxHost
text
IMAPAccount%dHost=pop.yourisp.com
IMAPAccountxPort
number
143
IMAPAccount%dPort=143
IMAPAccountxSSLIgnoreCertErrors
Ignore certificate errors when connecting using SSL
bool
On/Off, True/False, Yes/No, 1/0
Off
IMAPAccount%dSSLIgnoreCertErrors=Off
IMAPAccountxSSLOpenSSL
This will use the OpenSSL encryption system instead of Windows SSPI. Sometimes this can help work around SSL incompatibilies with older Windows versions connecting to newer servers.
For example Windows 2003 servers can have missing Cryptographic cipher sets required by newer servers. Rather than trying to install all the required hotfixes and
change the Windows Cipher set settings (registry entries) it can sometimes be quicker to just use OpenSSL instead
bool
On/Off, True/False, Yes/No, 1/0
Off
IMAPAccount%dSSLOpenSSL=Off
IMAPAccountxDiagLog
You can turn on diagnostic logging with this switch
bool
On/Off, True/False, Yes/No, 1/0
false
IMAPAccount%dDiagLog=false
IMAPAccountxRecipients
You can specify one recipient email addresses (example@domain.com),
or multiple using a comma to separate the addresses (example1@domain.com,example2@domain.com, andy*@test.com).
Email with these recipients will be uploaded to this IMAP account
You can specify one recipient email addresses (example@domain.com),
or multiple using a comma to separate the addresses (example1@domain.com,example2@domain.com, andy*@test.com).
Email with these senders will be uploaded to this IMAP account. This can be useful for uploading sent items to an imap accoutn sent items folder
in teh case where you are sending out email thru this product as a gateway and wish to keep an extra copy in an IMAP sent folder.
You can configure Hexamail POP3 Downloader to remap email to new folders.
Hexamail will automatically create folders that do not exist.
Use wildcards to map all matching folders to a new folder name, for example *Sent* -> Sent Items to map all folders containing the string Sent to a new Sent Items folder
The destination folder can also contain replacement tokens that hexamail will replace with information from the email being uploaded.
Supported replacements are:
<year> - year from email date
<mon> - month name (short) from email date
<month> - month name (long) from email date
<monnum> - month number (1 - 12) from email date
<day> - month day (1 - 31) from email date
<weekday> - week day (Monday,Tuesday,Wednesday,Thursday,Friday) from email date
<wday> - week day (Mon,Tue,Wed,Thu,Fri) from email date
<from> - email MIME from address
<fromdomain> - email MIME from address domain (e.g domain.com from user1@domain.com)
<fromuser> - email MIME from address user part (e.g user1 from user1@domain.com)
<to> - email MIME to address
<todomain> - email MIME to address domain
<touser> - email MIME to address user part
<subject> - email subject
<subjectclean> - email subject with all numbers, start and end spaces and punctuation characters removed
<header_headername>- email header matching headername
<folder> - email original folder name (last part e.g. Customers/customer1 becomes just customer1)
<folderrpath> - email original folder name (full path, e.g. Customers/customer1 )
text
IMAPAccount%dFolderMap=Inbox:OtherMail
*Sent*:Sent items
Old Email:Archive
*:Archive <year>/<folder;>/<fromdomain;>
*:Archive <year>/<folderpath;>
IMAPAccountxFolderForce
Force the email into a specific folder
text
IMAPAccountxCopy
Email can be copied or moved to the IMAP account. If it is moved then the email will not be processed further by Hexamail POP3 Downloader after uploading.
If it is copied the email will be processed further and typically eventually sent via SMTP to the recipients
bool
On/Off, True/False, Yes/No, 1/0
false
IMAPAccount%dCopy=false
IMAPAccountxMIMECompliance
Some servers like Office365 insist on compliant MIME payloads when pushing email using IMAP APPEND commands.
Hexamail normally just uploads the exact payload it received, however this may fail for sensitive servers. Hexamail then needs to reprocess and correct any email that are non compliant to ensure their acceptance by the server. This can break encryption, DKIM
and other formatting, and require more processing power.
text
off
IMAPAccount%dMIMECompliance=off
IMAPAccountxMIMELineLengthMax
Some mail servers and in particular versions of Exchange accept line lengths of 1000 characters, other only 77 characters (Office365).
You may receive a very descriptive error like "BAD Command Error. 10".
Use this setting to control the maximum line length when pushing email up over IMAP to work around the bugs in Microsoft products.
text
1000
IMAPAccount%dMIMELineLengthMax=77
IMAPAccountxMaxPushBatch
You can limit the total amount pushed per IMAP connection or session. Some servers may restrict the amount uploaded. This gives you some control to avoid being disconnected if you are uploading large volumes
text
4
IMAPAccount%dMaxPushBatch=4
AccountxAuthType
Most accounts require simple password authentication. If you are using Gmail, google mail, Office365 or Outlook.com you can use password authentication with either Legacy App access or App-passwords.
text
true
Account%dAuthType=true
AccountxAuthType
Google, Google Apps, Gmail, Office365 and Outlook.com accounts can require OAuth2 authentication. Use this option to use OAuth2 instead of App-password or legacy password authenticaton.
text
off
Account%dAuthType=off
AccountxOAuthButton
Sets up OAuth authentication for the account.
If you are downloading from a hosted cloud email service such as Gmail or Office365 you may need to choose OAuth2 authentication, and click the authenticate button to sign in and
get an authentication token.
text
AccountxOAuthToken
Stores the OAuth2 authentication token
text
AccountxOAuthADType
Stores the OAuth2 authentication type
text
AccountxOAuthState
Stores the OAuth2 authentication state
text
AccountxOAuthExpiry
Stores the OAuth2 authentication expiry time
number
DefaultServer
the default IMAP server you wish to connect to
localhost
DefaultServer=localhost
DefaultPort
the default port you wish the IMAP Push to connect to. It is usual to leave this on 143
143
DefaultPort=143
DefaultSSLPort
Default IMAP access over SSL is on port 993.
number
110 - 32000
993
DefaultSSLPort=993
MaxConnections
You can allow a large number of simultaneous connections to push large amounts of email simultaneously.
If all your IMAP push is to the same server do not set this too high as it will make little difference. The bottleneck will be the server.
number
16 - 4096
8
MaxConnections=32
AutoLogoutTime
IMAP Push keep open a permanent connection to the server.
You can use this setting to close the connection after a period of inactivity.
30 minutes
AutoLogoutTime=15
IMAPPushQueue
The IMAP Push queues email for push. It stores them in this directory
text
./emailimappush/
IMAPPushQueue=./emailimappush/
MaxRecvBandwidth
You can throttle the maximum bandwidth allowed for receiving information from the server. Typically you do not need to change this setting.
number
1 - 1000000 kbps
1000000 kbps
MaxRecvBandwidth=64
MaxSendBandwidth
You can throttle the maximum bandwidth allowed for sending email to the server. Typically you do not need to change this setting.
number
1 - 1000000 kbps
1000000 kbps
MaxSendBandwidth=64
DiagnosticLog
You can log the entire IMAP conversations to a log file for diagnostics/testing/issue resolution.
The IMAP conversation is written to a log file in the logs directory called logs/imappush_username.log.
NOTE: IMAP diagnostic logging will affect performance.